Platform Explorer / Nuxeo Platform 2021.61

Operation Document.RestoreVersion (Restore Version)

Description

Restores a document to the input version document. If createVersion is true, a version of the live document will be created before restoring it to the input version. If checkout is true, a checkout will be processed after restoring the document, visible in the UI by the '+' symbol beside the version number. Returns the restored document.
Operation id Document.RestoreVersion
Category Document
Label Restore Version
Requires
Since

Parameters

Name Description Type Required Default value
checkout boolean no false 
createVersion boolean no false 

Signature

Inputs document
Outputs document

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.document.RestoreVersion
Contributing Component org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.RestoreVersion",
  "label" : "Restore Version",
  "category" : "Document",
  "requires" : null,
  "description" : "Restores a document to the input version document. If createVersion is true, a version of the live document will be created before restoring it to the input version. If checkout is true, a checkout will be processed after restoring the document, visible in the UI by the '+' symbol beside the version number. Returns the restored document.",
  "url" : "Document.RestoreVersion",
  "signature" : [ "document", "document" ],
  "params" : [ {
    "name" : "checkout",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  }, {
    "name" : "createVersion",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  } ]
}